Simulate PIX QR Code conclusion

Sandbox environment only

This simulation endpoint is available only in the homologation environment. Do not use this route in production flows.

Use this route to simulate the conclusion of a PIX QR Code payment in the homologation environment.

Request

URL

POST 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/{id}/simulate-conclude'

cURL

curl --request POST \
     --url 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/{id}/simulate-conclude' \
     --header 'accept: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --header 'x-delfinance-account-id: {{accountId}}'

Headers

Name	Description
x-delbank-api-key	Required. API key
x-delfinance-account-id	Required. The Delfinance bank account number

Path parameters

Name	Type	Description
id	string	Required. QR Code identifier. You can use the transactionId or the correlationId.

Response

The expected response is 202 Accepted.

Error when the account is not the same account that created the QR Code

Status: 404 Not Found

{
  "title": "Please refer to the errors property for additional details.",
  "code": "QR_CODE_NOT_FOUND",
  "errors": [
    "QR Code não encontrado para o ID informado"
  ]
}

Payer data used in the simulation

The simulation uses payer data generated by the homologation environment.

{
  "payer": {
    "number": "00000001",
    "branch": "0001",
    "type": "PAYMENT",
    "participant": {
      "name": "BANCO DO BRASIL S.A.",
      "ispb": "00000000"
    },
    "holder": {
      "name": "DELBANK SIMULATOR",
      "document": "0000000000191",
      "type": "LEGAL"
    }
  }
}

Validations and behavior

• The same account that created the QR Code must be used to simulate the conclusion.
• When the QR Code has a defined amount, that amount will be used in the simulation.
• When the QR Code does not have a defined amount, mainly for static QR Codes, an amount between 1 and 10 reais will be generated.